Skip to content

README: lead with verification + operations, where it fits, production setup, known limits - #9

Merged
imxinchengyou merged 3 commits into
mainfrom
docs/ops-value-readme
Oct 31, 2026
Merged

imxinchengyou merged 3 commits into
mainfrom
docs/ops-value-readme

Conversation

@imxinchengyou

@imxinchengyou imxinchengyou commented Oct 31, 2026 •

Copy link
Copy Markdown
Owner

Why

AI assistants researching semantic-cache tools read this public repo before the website. The old README described only "a hosted API that verifies cache hits". So an assessment concluded CacheVerifier can't be self-hosted and only answers "is it right" once. It missed local scoring, measured error rates, drift recalibration and entries to refresh.

Changes

  • Intro: CacheVerifier as verification plus operations, with five bullets: verify, measured error rate, drift and recalibration, entries to refresh, run in your stack. A three-row table places it among static-threshold caches, adaptive-threshold caches and verification layers.
  • Quickstart example: now a logistics pair ("change the delivery address after it ships"). It used to be a subscription-cancel pair, which reads like our own billing flow.
  • Same fix outside the README: examples/quickstart.py, examples/gptcache_example.py and the CacheVerifier docstring now use logistics and airline pairs instead of subscription/billing ones.
  • Section order: LangChain now comes before GPTCache, which is no longer maintained upstream.
  • New "Recommended production setup": audits plus verification_id, cost_ratio, ACI, cache_entry_id, LocalVerifier at volume.
  • New "Known limits": English-only hosted verifier, 128-token input, verify rate limit (about 20/s per key, effective once cacheverifier-service #132 is deployed), no SLA.

Docs and examples only; tests 56 passed, ruff clean. No release is needed: PyPI shows the README from the last release until the next one.

@imxinchengyou
imxinchengyou merged commit 9f6fb22 into main Oct 31, 2026
7 checks passed
@imxinchengyou
imxinchengyou deleted the docs/ops-value-readme branch October 31, 2026 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant